<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>DateTimeField xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/goda/time/DateTimeField.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment">/**</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * Defines the calculation engine for date and time fields.</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * The interface defines a set of methods that manipulate a millisecond datetime</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * with regards to a single field, such as monthOfYear or secondOfMinute.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * This design is extensible so, if you wish, you can extract a different field from</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * the milliseconds. A number of standard implementations are provided to assist.</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> *</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * @author Guy Allard</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> */</em>
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/goda/time/DateTimeField.html">DateTimeField</a> {
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>      <em class="jxr_javadoccomment">/**</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">     * Get the type of the field.</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">     * </em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">     * @return field type</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">     */</em>
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> getType();
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>      <em class="jxr_javadoccomment">/**</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * Get the name of the field.</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * By convention, names follow a pattern of "dddOfRrr", where "ddd" represents</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * the (singular) duration unit field name and "Rrr" represents the (singular)</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * duration range field name. If the range field is not applicable, then</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * the name of the field is simply the (singular) duration field name.</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * </em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     * @return field name</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     */</em>
<a name="52" href="#52">52</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getName();
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>      <em class="jxr_javadoccomment">/**</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * Returns true if this field is supported.</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * </em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * @return true if this field is supported</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     */</em>
<a name="59" href="#59">59</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> isSupported();
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>      <em class="jxr_javadoccomment">/**</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * Returns true if the set method is lenient. If so, it accepts values that</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * are out of bounds. For example, a lenient day of month field accepts 32</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * for January, converting it to February 1.</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * </em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * @return true if this field is lenient</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     */</em>
<a name="68" href="#68">68</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> isLenient();
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <em class="jxr_comment">// Main access API</em>
<a name="71" href="#71">71</a>      <em class="jxr_comment">//------------------------------------------------------------------------</em>
<a name="72" href="#72">72</a>      <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * Get the value of this field from the milliseconds.</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * </em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * @return the value of the field, in the units of the field</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     */</em>
<a name="78" href="#78">78</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> get(<strong class="jxr_keyword">long</strong> instant);
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * Get the human-readable, text value of this field from the milliseconds.</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     *</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * @param locale the locale to use for selecting a text symbol, null for default</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     */</em>
<a name="88" href="#88">88</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsText(<strong class="jxr_keyword">long</strong> instant, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <em class="jxr_javadoccomment">/**</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     * Get the human-readable, text value of this field from the milliseconds.</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * </em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     */</em>
<a name="96" href="#96">96</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsText(<strong class="jxr_keyword">long</strong> instant);
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * Get the human-readable, text value of this field from a partial instant.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     *</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * @param partial  the partial instant to query</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @param fieldValue  the field value of this field, provided for performance</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use for selecting a text symbol, null for default</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">     */</em>
<a name="107" href="#107">107</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsText(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> partial, <strong class="jxr_keyword">int</strong> fieldValue, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <em class="jxr_javadoccomment">/**</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * Get the human-readable, text value of this field from a partial instant.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     *</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * @param partial  the partial instant to query</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use for selecting a text symbol, null for default</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     */</em>
<a name="117" href="#117">117</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsText(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> partial, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em class="jxr_javadoccomment">/**</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * Get the human-readable, text value of this field from the field value.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     *</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * @param fieldValue  the numeric value to convert to text</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * @param locale the locale to use for selecting a text symbol, null for default</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     */</em>
<a name="127" href="#127">127</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsText(<strong class="jxr_keyword">int</strong> fieldValue, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>     <em class="jxr_javadoccomment">/**</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * Get the human-readable, short text value of this field from the</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * milliseconds.  If the specified locale is null, the default locale is used.</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     *</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @param locale the locale to use for selecting a text symbol, null for default</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * @return the short text value of the field</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     */</em>
<a name="137" href="#137">137</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsShortText(<strong class="jxr_keyword">long</strong> instant, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a>     <em class="jxr_javadoccomment">/**</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * Get the human-readable, short text value of this field from the</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * milliseconds.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * </em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @return the short text value of the field</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     */</em>
<a name="146" href="#146">146</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsShortText(<strong class="jxr_keyword">long</strong> instant);
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>     <em class="jxr_javadoccomment">/**</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * Get the human-readable, short text value of this field from a partial instant.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     *</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * @param partial  the partial instant to query</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * @param fieldValue  the field value of this field, provided for performance</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use for selecting a text symbol, null for default</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     */</em>
<a name="157" href="#157">157</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsShortText(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> partial, <strong class="jxr_keyword">int</strong> fieldValue, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>     <em class="jxr_javadoccomment">/**</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * Get the human-readable, short text value of this field from a partial instant.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     *</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @param partial  the partial instant to query</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use for selecting a text symbol, null for default</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     */</em>
<a name="167" href="#167">167</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsShortText(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> partial, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em class="jxr_javadoccomment">/**</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * Get the human-readable, short text value of this field from the field value.</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     *</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * @param fieldValue  the numeric value to convert to text</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     * @param locale the locale to use for selecting a text symbol, null for default</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     * @return the text value of the field</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     */</em>
<a name="177" href="#177">177</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getAsShortText(<strong class="jxr_keyword">int</strong> fieldValue, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>     <em class="jxr_javadoccomment">/**</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * Adds a value (which may be negative) to the millis value,</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * overflowing into larger fields if necessary.</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * The value will be added to this field. If the value is too large to be</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * added solely to this field, larger fields will increase as required.</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * Smaller fields should be unaffected, except where the result would be</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * an invalid value for a smaller field. In this case the smaller field is</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     * adjusted to be in range.</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment">     * For example, in the ISO chronology:&lt;br&gt;</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     * 2000-08-20 add six months is 2001-02-20&lt;br&gt;</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">     * 2000-08-20 add twenty months is 2002-04-20&lt;br&gt;</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     * 2000-08-20 add minus nine months is 1999-11-20&lt;br&gt;</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * 2001-01-31 add one month  is 2001-02-28&lt;br&gt;</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * 2001-01-31 add two months is 2001-03-31&lt;br&gt;</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     * </em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to add to</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     * @param value  the value to add, in the units of the field</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * @return the updated milliseconds</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     */</em>
<a name="200" href="#200">200</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> add(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> value);
<a name="201" href="#201">201</a> 
<a name="202" href="#202">202</a>     <em class="jxr_javadoccomment">/**</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * Adds a value (which may be negative) to the millis value,</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * overflowing into larger fields if necessary.</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * </em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to add to</em>
<a name="207" href="#207">207</a> <em class="jxr_javadoccomment">     * @param value  the long value to add, in the units of the field</em>
<a name="208" href="#208">208</a> <em class="jxr_javadoccomment">     * @return the updated milliseconds</em>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if value is too large</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     * @see #add(long,int)</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     */</em>
<a name="212" href="#212">212</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> add(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">long</strong> value);
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>     <em class="jxr_javadoccomment">/**</em>
<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * Adds a value (which may be negative) to the partial instant,</em>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     * throwing an exception if the maximum size of the instant is reached.</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * The value will be added to this field, overflowing into larger fields</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     * if necessary. Smaller fields should be unaffected, except where the</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment">     * result would be an invalid value for a smaller field. In this case the</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment">     * smaller field is adjusted to be in range.</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * Partial instants only contain some fields. This may result in a maximum</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * possible value, such as TimeOfDay being limited to 23:59:59:999. If this</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * limit is breached by the add an exception is thrown.</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * For example, in the ISO chronology:&lt;br&gt;</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * 2000-08-20 add six months is 2000-02-20&lt;br&gt;</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     * 2000-08-20 add twenty months is 2000-04-20&lt;br&gt;</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     * 2000-08-20 add minus nine months is 2000-11-20&lt;br&gt;</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * 2001-01-31 add one month  is 2001-02-28&lt;br&gt;</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     * 2001-01-31 add two months is 2001-03-31&lt;br&gt;</em>
<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     * </em>
<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant</em>
<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * @param fieldIndex  the index of this field in the instant</em>
<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * @param values  the values of the partial instant which should be updated</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * @param valueToAdd  the value to add, in the units of the field</em>
<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * @return the passed in values</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid or the maximum instant is reached</em>
<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     */</em>
<a name="241" href="#241">241</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong>[] add(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong> fieldIndex, <strong class="jxr_keyword">int</strong>[] values, <strong class="jxr_keyword">int</strong> valueToAdd);
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a>     <em class="jxr_javadoccomment">/**</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * Adds a value (which may be negative) to the partial instant,</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * wrapping the whole partial if the maximum size of the partial is reached.</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     * The value will be added to this field, overflowing into larger fields</em>
<a name="248" href="#248">248</a> <em class="jxr_javadoccomment">     * if necessary. Smaller fields should be unaffected, except where the</em>
<a name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * result would be an invalid value for a smaller field. In this case the</em>
<a name="250" href="#250">250</a> <em class="jxr_javadoccomment">     * smaller field is adjusted to be in range.</em>
<a name="251" href="#251">251</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">     * Partial instants only contain some fields. This may result in a maximum</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">     * possible value, such as TimeOfDay normally being limited to 23:59:59:999.</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * If ths limit is reached by the addition, this method will wrap back to</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     * 00:00:00.000. In fact, you would generally only use this method for</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     * classes that have a limitation such as this.</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     * For example, in the ISO chronology:&lt;br&gt;</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * 10:20:30 add 20 minutes is 10:40:30&lt;br&gt;</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment">     * 10:20:30 add 45 minutes is 11:05:30&lt;br&gt;</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     * 10:20:30 add 16 hours is 02:20:30&lt;br&gt;</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">     * </em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment">     * @param fieldIndex  the index of this field in the partial</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * @param values  the values of the partial instant which should be updated</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * @param valueToAdd  the value to add, in the units of the field</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * @return the passed in values</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid or the maximum instant is reached</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     */</em>
<a name="270" href="#270">270</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong>[] addWrapPartial(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong> fieldIndex, <strong class="jxr_keyword">int</strong>[] values, <strong class="jxr_keyword">int</strong> valueToAdd);
<a name="271" href="#271">271</a> 
<a name="272" href="#272">272</a>     <em class="jxr_javadoccomment">/**</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * Adds a value (which may be negative) to the millis value,</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * wrapping within this field.</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * The value will be added to this field. If the value is too large to be</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * added solely to this field then it wraps. Larger fields are always</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * unaffected. Smaller fields should be unaffected, except where the</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * result would be an invalid value for a smaller field. In this case the</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * smaller field is adjusted to be in range.</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">     * For example, in the ISO chronology:&lt;br&gt;</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * 2000-08-20 addWrapField six months is 2000-02-20&lt;br&gt;</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     * 2000-08-20 addWrapField twenty months is 2000-04-20&lt;br&gt;</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * 2000-08-20 addWrapField minus nine months is 2000-11-20&lt;br&gt;</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * 2001-01-31 addWrapField one month  is 2001-02-28&lt;br&gt;</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     * 2001-01-31 addWrapField two months is 2001-03-31&lt;br&gt;</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * </em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to add to</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     * @param value  the value to add, in the units of the field</em>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * @return the updated milliseconds</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment">     */</em>
<a name="293" href="#293">293</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> addWrapField(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> value) ;
<a name="294" href="#294">294</a> 
<a name="295" href="#295">295</a>     <em class="jxr_javadoccomment">/**</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * Adds a value (which may be negative) to the partial instant,</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     * wrapping within this field.</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * The value will be added to this field. If the value is too large to be</em>
<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">     * added solely to this field then it wraps. Larger fields are always</em>
<a name="301" href="#301">301</a> <em class="jxr_javadoccomment">     * unaffected. Smaller fields should be unaffected, except where the</em>
<a name="302" href="#302">302</a> <em class="jxr_javadoccomment">     * result would be an invalid value for a smaller field. In this case the</em>
<a name="303" href="#303">303</a> <em class="jxr_javadoccomment">     * smaller field is adjusted to be in range.</em>
<a name="304" href="#304">304</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">     * For example, in the ISO chronology:&lt;br&gt;</em>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">     * 2000-08-20 addWrapField six months is 2000-02-20&lt;br&gt;</em>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * 2000-08-20 addWrapField twenty months is 2000-04-20&lt;br&gt;</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     * 2000-08-20 addWrapField minus nine months is 2000-11-20&lt;br&gt;</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * 2001-01-31 addWrapField one month  is 2001-02-28&lt;br&gt;</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * 2001-01-31 addWrapField two months is 2001-03-31&lt;br&gt;</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     * </em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">     * @param fieldIndex  the index of this field in the instant</em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * @param values  the values of the partial instant which should be updated</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     * @param valueToAdd  the value to add, in the units of the field</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     * @return the passed in values</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     */</em>
<a name="319" href="#319">319</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong>[] addWrapField(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong> fieldIndex, <strong class="jxr_keyword">int</strong>[] values, <strong class="jxr_keyword">int</strong> valueToAdd);
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a>     <em class="jxr_javadoccomment">/**</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     * Computes the difference between two instants, as measured in the units</em>
<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">     * of this field. Any fractional units are dropped from the result. Calling</em>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">     * getDifference reverses the effect of calling add. In the following code:</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment">     *</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">     * long instant = ...</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     * int v = ...</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment">     * int age = getDifference(add(instant, v), instant);</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">     *</em>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * The value 'age' is the same as the value 'v'.</em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     *</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * @param minuendInstant the milliseconds from 1970-01-01T00:00:00Z to</em>
<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">     * subtract from</em>
<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * @param subtrahendInstant the milliseconds from 1970-01-01T00:00:00Z to</em>
<a name="337" href="#337">337</a> <em class="jxr_javadoccomment">     * subtract off the minuend</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">     * @return the difference in the units of this field</em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment">     */</em>
<a name="340" href="#340">340</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getDifference(<strong class="jxr_keyword">long</strong> minuendInstant, <strong class="jxr_keyword">long</strong> subtrahendInstant);
<a name="341" href="#341">341</a> 
<a name="342" href="#342">342</a>     <em class="jxr_javadoccomment">/**</em>
<a name="343" href="#343">343</a> <em class="jxr_javadoccomment">     * Computes the difference between two instants, as measured in the units</em>
<a name="344" href="#344">344</a> <em class="jxr_javadoccomment">     * of this field. Any fractional units are dropped from the result. Calling</em>
<a name="345" href="#345">345</a> <em class="jxr_javadoccomment">     * getDifference reverses the effect of calling add. In the following code:</em>
<a name="346" href="#346">346</a> <em class="jxr_javadoccomment">     *</em>
<a name="347" href="#347">347</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">     * long instant = ...</em>
<a name="349" href="#349">349</a> <em class="jxr_javadoccomment">     * long v = ...</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">     * long age = getDifferenceAsLong(add(instant, v), instant);</em>
<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="352" href="#352">352</a> <em class="jxr_javadoccomment">     *</em>
<a name="353" href="#353">353</a> <em class="jxr_javadoccomment">     * The value 'age' is the same as the value 'v'.</em>
<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     *</em>
<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">     * @param minuendInstant the milliseconds from 1970-01-01T00:00:00Z to</em>
<a name="356" href="#356">356</a> <em class="jxr_javadoccomment">     * subtract from</em>
<a name="357" href="#357">357</a> <em class="jxr_javadoccomment">     * @param subtrahendInstant the milliseconds from 1970-01-01T00:00:00Z to</em>
<a name="358" href="#358">358</a> <em class="jxr_javadoccomment">     * subtract off the minuend</em>
<a name="359" href="#359">359</a> <em class="jxr_javadoccomment">     * @return the difference in the units of this field</em>
<a name="360" href="#360">360</a> <em class="jxr_javadoccomment">     */</em>
<a name="361" href="#361">361</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> getDifferenceAsLong(<strong class="jxr_keyword">long</strong> minuendInstant, <strong class="jxr_keyword">long</strong> subtrahendInstant);
<a name="362" href="#362">362</a> 
<a name="363" href="#363">363</a>     <em class="jxr_javadoccomment">/**</em>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">     * Sets a value in the milliseconds supplied.</em>
<a name="365" href="#365">365</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="366" href="#366">366</a> <em class="jxr_javadoccomment">     * The value of this field will be set.</em>
<a name="367" href="#367">367</a> <em class="jxr_javadoccomment">     * If the value is invalid, an exception if thrown.</em>
<a name="368" href="#368">368</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="369" href="#369">369</a> <em class="jxr_javadoccomment">     * If setting this field would make other fields invalid, then those fields</em>
<a name="370" href="#370">370</a> <em class="jxr_javadoccomment">     * may be changed. For example if the current date is the 31st January, and</em>
<a name="371" href="#371">371</a> <em class="jxr_javadoccomment">     * the month is set to February, the day would be invalid. Instead, the day</em>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * would be changed to the closest value - the 28th/29th February as appropriate.</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * </em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to set in</em>
<a name="375" href="#375">375</a> <em class="jxr_javadoccomment">     * @param value  the value to set, in the units of the field</em>
<a name="376" href="#376">376</a> <em class="jxr_javadoccomment">     * @return the updated milliseconds</em>
<a name="377" href="#377">377</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="378" href="#378">378</a> <em class="jxr_javadoccomment">     */</em>
<a name="379" href="#379">379</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> set(<strong class="jxr_keyword">long</strong> instant, <strong class="jxr_keyword">int</strong> value);
<a name="380" href="#380">380</a> 
<a name="381" href="#381">381</a>     <em class="jxr_javadoccomment">/**</em>
<a name="382" href="#382">382</a> <em class="jxr_javadoccomment">     * Sets a value using the specified partial instant.</em>
<a name="383" href="#383">383</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="384" href="#384">384</a> <em class="jxr_javadoccomment">     * The value of this field (specified by the index) will be set.</em>
<a name="385" href="#385">385</a> <em class="jxr_javadoccomment">     * If the value is invalid, an exception if thrown.</em>
<a name="386" href="#386">386</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="387" href="#387">387</a> <em class="jxr_javadoccomment">     * If setting this field would make other fields invalid, then those fields</em>
<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * may be changed. For example if the current date is the 31st January, and</em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment">     * the month is set to February, the day would be invalid. Instead, the day</em>
<a name="390" href="#390">390</a> <em class="jxr_javadoccomment">     * would be changed to the closest value - the 28th/29th February as appropriate.</em>
<a name="391" href="#391">391</a> <em class="jxr_javadoccomment">     * </em>
<a name="392" href="#392">392</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant</em>
<a name="393" href="#393">393</a> <em class="jxr_javadoccomment">     * @param fieldIndex  the index of this field in the instant</em>
<a name="394" href="#394">394</a> <em class="jxr_javadoccomment">     * @param values  the values of the partial instant which should be updated</em>
<a name="395" href="#395">395</a> <em class="jxr_javadoccomment">     * @param newValue  the value to set, in the units of the field</em>
<a name="396" href="#396">396</a> <em class="jxr_javadoccomment">     * @return the passed in values</em>
<a name="397" href="#397">397</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="398" href="#398">398</a> <em class="jxr_javadoccomment">     */</em>
<a name="399" href="#399">399</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong>[] set(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong> fieldIndex, <strong class="jxr_keyword">int</strong>[] values, <strong class="jxr_keyword">int</strong> newValue);
<a name="400" href="#400">400</a> 
<a name="401" href="#401">401</a>     <em class="jxr_javadoccomment">/**</em>
<a name="402" href="#402">402</a> <em class="jxr_javadoccomment">     * Sets a value in the milliseconds supplied from a human-readable, text value.</em>
<a name="403" href="#403">403</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="405" href="#405">405</a> <em class="jxr_javadoccomment">     * If setting this field would make other fields invalid, then those fields</em>
<a name="406" href="#406">406</a> <em class="jxr_javadoccomment">     * may be changed. For example if the current date is the 31st January, and</em>
<a name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * the month is set to February, the day would be invalid. Instead, the day</em>
<a name="408" href="#408">408</a> <em class="jxr_javadoccomment">     * would be changed to the closest value - the 28th/29th February as appropriate.</em>
<a name="409" href="#409">409</a> <em class="jxr_javadoccomment">     *</em>
<a name="410" href="#410">410</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to set in</em>
<a name="411" href="#411">411</a> <em class="jxr_javadoccomment">     * @param text  the text value to set</em>
<a name="412" href="#412">412</a> <em class="jxr_javadoccomment">     * @param locale the locale to use for selecting a text symbol, null for default</em>
<a name="413" href="#413">413</a> <em class="jxr_javadoccomment">     * @return the updated milliseconds</em>
<a name="414" href="#414">414</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the text value is invalid</em>
<a name="415" href="#415">415</a> <em class="jxr_javadoccomment">     */</em>
<a name="416" href="#416">416</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> set(<strong class="jxr_keyword">long</strong> instant, String text, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="417" href="#417">417</a> 
<a name="418" href="#418">418</a>     <em class="jxr_javadoccomment">/**</em>
<a name="419" href="#419">419</a> <em class="jxr_javadoccomment">     * Sets a value in the milliseconds supplied from a human-readable, text value.</em>
<a name="420" href="#420">420</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment">     * If setting this field would make other fields invalid, then those fields</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment">     * may be changed. For example if the current date is the 31st January, and</em>
<a name="423" href="#423">423</a> <em class="jxr_javadoccomment">     * the month is set to February, the day would be invalid. Instead, the day</em>
<a name="424" href="#424">424</a> <em class="jxr_javadoccomment">     * would be changed to the closest value - the 28th/29th February as appropriate.</em>
<a name="425" href="#425">425</a> <em class="jxr_javadoccomment">     * </em>
<a name="426" href="#426">426</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to set in</em>
<a name="427" href="#427">427</a> <em class="jxr_javadoccomment">     * @param text  the text value to set</em>
<a name="428" href="#428">428</a> <em class="jxr_javadoccomment">     * @return the updated milliseconds</em>
<a name="429" href="#429">429</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the text value is invalid</em>
<a name="430" href="#430">430</a> <em class="jxr_javadoccomment">     */</em>
<a name="431" href="#431">431</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> set(<strong class="jxr_keyword">long</strong> instant, String text);
<a name="432" href="#432">432</a> 
<a name="433" href="#433">433</a>     <em class="jxr_javadoccomment">/**</em>
<a name="434" href="#434">434</a> <em class="jxr_javadoccomment">     * Sets a value in the milliseconds supplied from a human-readable, text value.</em>
<a name="435" href="#435">435</a> <em class="jxr_javadoccomment">     * If the specified locale is null, the default locale is used.</em>
<a name="436" href="#436">436</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="437" href="#437">437</a> <em class="jxr_javadoccomment">     * If setting this field would make other fields invalid, then those fields</em>
<a name="438" href="#438">438</a> <em class="jxr_javadoccomment">     * may be changed. For example if the current date is the 31st January, and</em>
<a name="439" href="#439">439</a> <em class="jxr_javadoccomment">     * the month is set to February, the day would be invalid. Instead, the day</em>
<a name="440" href="#440">440</a> <em class="jxr_javadoccomment">     * would be changed to the closest value - the 28th/29th February as appropriate.</em>
<a name="441" href="#441">441</a> <em class="jxr_javadoccomment">     *</em>
<a name="442" href="#442">442</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant</em>
<a name="443" href="#443">443</a> <em class="jxr_javadoccomment">     * @param fieldIndex  the index of this field in the instant</em>
<a name="444" href="#444">444</a> <em class="jxr_javadoccomment">     * @param values  the values of the partial instant which should be updated</em>
<a name="445" href="#445">445</a> <em class="jxr_javadoccomment">     * @param text  the text value to set</em>
<a name="446" href="#446">446</a> <em class="jxr_javadoccomment">     * @param locale the locale to use for selecting a text symbol, null for default</em>
<a name="447" href="#447">447</a> <em class="jxr_javadoccomment">     * @return the passed in values</em>
<a name="448" href="#448">448</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the text value is invalid</em>
<a name="449" href="#449">449</a> <em class="jxr_javadoccomment">     */</em>
<a name="450" href="#450">450</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong>[] set(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong> fieldIndex, <strong class="jxr_keyword">int</strong>[] values, String text, <a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="451" href="#451">451</a> 
<a name="452" href="#452">452</a>     <em class="jxr_comment">// Extra information API</em>
<a name="453" href="#453">453</a>     <em class="jxr_comment">//------------------------------------------------------------------------</em>
<a name="454" href="#454">454</a>     <em class="jxr_javadoccomment">/**</em>
<a name="455" href="#455">455</a> <em class="jxr_javadoccomment">     * Returns the duration per unit value of this field. For example, if this</em>
<a name="456" href="#456">456</a> <em class="jxr_javadoccomment">     * field represents "hour of day", then the duration is an hour.</em>
<a name="457" href="#457">457</a> <em class="jxr_javadoccomment">     *</em>
<a name="458" href="#458">458</a> <em class="jxr_javadoccomment">     * @return the duration of this field, or UnsupportedDurationField if field</em>
<a name="459" href="#459">459</a> <em class="jxr_javadoccomment">     * has no duration</em>
<a name="460" href="#460">460</a> <em class="jxr_javadoccomment">     */</em>
<a name="461" href="#461">461</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../org/goda/time/DurationField.html">DurationField</a> getDurationField();
<a name="462" href="#462">462</a> 
<a name="463" href="#463">463</a>     <em class="jxr_javadoccomment">/**</em>
<a name="464" href="#464">464</a> <em class="jxr_javadoccomment">     * Returns the range duration of this field. For example, if this field</em>
<a name="465" href="#465">465</a> <em class="jxr_javadoccomment">     * represents "hour of day", then the range duration is a day.</em>
<a name="466" href="#466">466</a> <em class="jxr_javadoccomment">     *</em>
<a name="467" href="#467">467</a> <em class="jxr_javadoccomment">     * @return the range duration of this field, or null if field has no range</em>
<a name="468" href="#468">468</a> <em class="jxr_javadoccomment">     */</em>
<a name="469" href="#469">469</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../org/goda/time/DurationField.html">DurationField</a> getRangeDurationField();
<a name="470" href="#470">470</a> 
<a name="471" href="#471">471</a>     <em class="jxr_javadoccomment">/**</em>
<a name="472" href="#472">472</a> <em class="jxr_javadoccomment">     * Returns whether this field is 'leap' for the specified instant.</em>
<a name="473" href="#473">473</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="474" href="#474">474</a> <em class="jxr_javadoccomment">     * For example, a leap year would return true, a non leap year would return</em>
<a name="475" href="#475">475</a> <em class="jxr_javadoccomment">     * false.</em>
<a name="476" href="#476">476</a> <em class="jxr_javadoccomment">     * </em>
<a name="477" href="#477">477</a> <em class="jxr_javadoccomment">     * @param instant  the instant to check for leap status</em>
<a name="478" href="#478">478</a> <em class="jxr_javadoccomment">     * @return true if the field is 'leap'</em>
<a name="479" href="#479">479</a> <em class="jxr_javadoccomment">     */</em>
<a name="480" href="#480">480</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> isLeap(<strong class="jxr_keyword">long</strong> instant);
<a name="481" href="#481">481</a> 
<a name="482" href="#482">482</a>     <em class="jxr_javadoccomment">/**</em>
<a name="483" href="#483">483</a> <em class="jxr_javadoccomment">     * Gets the amount by which this field is 'leap' for the specified instant.</em>
<a name="484" href="#484">484</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="485" href="#485">485</a> <em class="jxr_javadoccomment">     * For example, a leap year would return one, a non leap year would return</em>
<a name="486" href="#486">486</a> <em class="jxr_javadoccomment">     * zero.</em>
<a name="487" href="#487">487</a> <em class="jxr_javadoccomment">     * </em>
<a name="488" href="#488">488</a> <em class="jxr_javadoccomment">     * @param instant  the instant to check for leap status</em>
<a name="489" href="#489">489</a> <em class="jxr_javadoccomment">     * @return the amount, in units of the leap duration field, that the field is leap</em>
<a name="490" href="#490">490</a> <em class="jxr_javadoccomment">     */</em>
<a name="491" href="#491">491</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getLeapAmount(<strong class="jxr_keyword">long</strong> instant);
<a name="492" href="#492">492</a> 
<a name="493" href="#493">493</a>     <em class="jxr_javadoccomment">/**</em>
<a name="494" href="#494">494</a> <em class="jxr_javadoccomment">     * If this field were to leap, then it would be in units described by the</em>
<a name="495" href="#495">495</a> <em class="jxr_javadoccomment">     * returned duration. If this field doesn't ever leap, null is returned.</em>
<a name="496" href="#496">496</a> <em class="jxr_javadoccomment">     * </em>
<a name="497" href="#497">497</a> <em class="jxr_javadoccomment">     * @return the leap duration field if field can be leap, null if it can't</em>
<a name="498" href="#498">498</a> <em class="jxr_javadoccomment">     */</em>
<a name="499" href="#499">499</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../org/goda/time/DurationField.html">DurationField</a> getLeapDurationField();
<a name="500" href="#500">500</a> 
<a name="501" href="#501">501</a>     <em class="jxr_javadoccomment">/**</em>
<a name="502" href="#502">502</a> <em class="jxr_javadoccomment">     * Get the minimum allowable value for this field.</em>
<a name="503" href="#503">503</a> <em class="jxr_javadoccomment">     * </em>
<a name="504" href="#504">504</a> <em class="jxr_javadoccomment">     * @return the minimum valid value for this field, in the units of the</em>
<a name="505" href="#505">505</a> <em class="jxr_javadoccomment">     * field</em>
<a name="506" href="#506">506</a> <em class="jxr_javadoccomment">     */</em>
<a name="507" href="#507">507</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMinimumValue();
<a name="508" href="#508">508</a> 
<a name="509" href="#509">509</a>     <em class="jxr_javadoccomment">/**</em>
<a name="510" href="#510">510</a> <em class="jxr_javadoccomment">     * Get the minimum value for this field evaluated at the specified time.</em>
<a name="511" href="#511">511</a> <em class="jxr_javadoccomment">     * </em>
<a name="512" href="#512">512</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="513" href="#513">513</a> <em class="jxr_javadoccomment">     * @return the minimum value for this field, in the units of the field</em>
<a name="514" href="#514">514</a> <em class="jxr_javadoccomment">     */</em>
<a name="515" href="#515">515</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMinimumValue(<strong class="jxr_keyword">long</strong> instant);
<a name="516" href="#516">516</a> 
<a name="517" href="#517">517</a>     <em class="jxr_javadoccomment">/**</em>
<a name="518" href="#518">518</a> <em class="jxr_javadoccomment">     * Get the minimum value for this field evaluated at the specified time.</em>
<a name="519" href="#519">519</a> <em class="jxr_javadoccomment">     * </em>
<a name="520" href="#520">520</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant to query</em>
<a name="521" href="#521">521</a> <em class="jxr_javadoccomment">     * @return the minimum value for this field, in the units of the field</em>
<a name="522" href="#522">522</a> <em class="jxr_javadoccomment">     */</em>
<a name="523" href="#523">523</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMinimumValue(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant);
<a name="524" href="#524">524</a> 
<a name="525" href="#525">525</a>     <em class="jxr_javadoccomment">/**</em>
<a name="526" href="#526">526</a> <em class="jxr_javadoccomment">     * Get the minimum value for this field using the partial instant and</em>
<a name="527" href="#527">527</a> <em class="jxr_javadoccomment">     * the specified values.</em>
<a name="528" href="#528">528</a> <em class="jxr_javadoccomment">     * </em>
<a name="529" href="#529">529</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant to query</em>
<a name="530" href="#530">530</a> <em class="jxr_javadoccomment">     * @param values  the values to use</em>
<a name="531" href="#531">531</a> <em class="jxr_javadoccomment">     * @return the minimum value for this field, in the units of the field</em>
<a name="532" href="#532">532</a> <em class="jxr_javadoccomment">     */</em>
<a name="533" href="#533">533</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMinimumValue(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong>[] values);
<a name="534" href="#534">534</a> 
<a name="535" href="#535">535</a>     <em class="jxr_javadoccomment">/**</em>
<a name="536" href="#536">536</a> <em class="jxr_javadoccomment">     * Get the maximum allowable value for this field.</em>
<a name="537" href="#537">537</a> <em class="jxr_javadoccomment">     * </em>
<a name="538" href="#538">538</a> <em class="jxr_javadoccomment">     * @return the maximum valid value for this field, in the units of the</em>
<a name="539" href="#539">539</a> <em class="jxr_javadoccomment">     * field</em>
<a name="540" href="#540">540</a> <em class="jxr_javadoccomment">     */</em>
<a name="541" href="#541">541</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMaximumValue();
<a name="542" href="#542">542</a> 
<a name="543" href="#543">543</a>     <em class="jxr_javadoccomment">/**</em>
<a name="544" href="#544">544</a> <em class="jxr_javadoccomment">     * Get the maximum value for this field evaluated at the specified time.</em>
<a name="545" href="#545">545</a> <em class="jxr_javadoccomment">     * </em>
<a name="546" href="#546">546</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to query</em>
<a name="547" href="#547">547</a> <em class="jxr_javadoccomment">     * @return the maximum value for this field, in the units of the field</em>
<a name="548" href="#548">548</a> <em class="jxr_javadoccomment">     */</em>
<a name="549" href="#549">549</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMaximumValue(<strong class="jxr_keyword">long</strong> instant);
<a name="550" href="#550">550</a> 
<a name="551" href="#551">551</a>     <em class="jxr_javadoccomment">/**</em>
<a name="552" href="#552">552</a> <em class="jxr_javadoccomment">     * Get the maximum value for this field evaluated at the specified time.</em>
<a name="553" href="#553">553</a> <em class="jxr_javadoccomment">     * </em>
<a name="554" href="#554">554</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant to query</em>
<a name="555" href="#555">555</a> <em class="jxr_javadoccomment">     * @return the maximum value for this field, in the units of the field</em>
<a name="556" href="#556">556</a> <em class="jxr_javadoccomment">     */</em>
<a name="557" href="#557">557</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMaximumValue(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant);
<a name="558" href="#558">558</a> 
<a name="559" href="#559">559</a>     <em class="jxr_javadoccomment">/**</em>
<a name="560" href="#560">560</a> <em class="jxr_javadoccomment">     * Get the maximum value for this field using the partial instant and</em>
<a name="561" href="#561">561</a> <em class="jxr_javadoccomment">     * the specified values.</em>
<a name="562" href="#562">562</a> <em class="jxr_javadoccomment">     * </em>
<a name="563" href="#563">563</a> <em class="jxr_javadoccomment">     * @param instant  the partial instant to query</em>
<a name="564" href="#564">564</a> <em class="jxr_javadoccomment">     * @param values  the values to use</em>
<a name="565" href="#565">565</a> <em class="jxr_javadoccomment">     * @return the maximum value for this field, in the units of the field</em>
<a name="566" href="#566">566</a> <em class="jxr_javadoccomment">     */</em>
<a name="567" href="#567">567</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMaximumValue(<a href="../../../org/goda/time/ReadablePartial.html">ReadablePartial</a> instant, <strong class="jxr_keyword">int</strong>[] values);
<a name="568" href="#568">568</a> 
<a name="569" href="#569">569</a>     <em class="jxr_javadoccomment">/**</em>
<a name="570" href="#570">570</a> <em class="jxr_javadoccomment">     * Get the maximum text value for this field.</em>
<a name="571" href="#571">571</a> <em class="jxr_javadoccomment">     * </em>
<a name="572" href="#572">572</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use for selecting a text symbol</em>
<a name="573" href="#573">573</a> <em class="jxr_javadoccomment">     * @return the maximum text length</em>
<a name="574" href="#574">574</a> <em class="jxr_javadoccomment">     */</em>
<a name="575" href="#575">575</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMaximumTextLength(<a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="576" href="#576">576</a> 
<a name="577" href="#577">577</a>     <em class="jxr_javadoccomment">/**</em>
<a name="578" href="#578">578</a> <em class="jxr_javadoccomment">     * Get the maximum short text value for this field.</em>
<a name="579" href="#579">579</a> <em class="jxr_javadoccomment">     * </em>
<a name="580" href="#580">580</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use for selecting a text symbol</em>
<a name="581" href="#581">581</a> <em class="jxr_javadoccomment">     * @return the maximum short text length</em>
<a name="582" href="#582">582</a> <em class="jxr_javadoccomment">     */</em>
<a name="583" href="#583">583</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getMaximumShortTextLength(<a href="../../../java/util/Locale.html">Locale</a> locale);
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a>     <em class="jxr_comment">// Calculation API</em>
<a name="586" href="#586">586</a>     <em class="jxr_comment">//------------------------------------------------------------------------</em>
<a name="587" href="#587">587</a>     <em class="jxr_javadoccomment">/**</em>
<a name="588" href="#588">588</a> <em class="jxr_javadoccomment">     * Round to the lowest whole unit of this field. After rounding, the value</em>
<a name="589" href="#589">589</a> <em class="jxr_javadoccomment">     * of this field and all fields of a higher magnitude are retained. The</em>
<a name="590" href="#590">590</a> <em class="jxr_javadoccomment">     * fractional millis that cannot be expressed in whole increments of this</em>
<a name="591" href="#591">591</a> <em class="jxr_javadoccomment">     * field are set to minimum.</em>
<a name="592" href="#592">592</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="593" href="#593">593</a> <em class="jxr_javadoccomment">     * For example, a datetime of 2002-11-02T23:34:56.789, rounded to the</em>
<a name="594" href="#594">594</a> <em class="jxr_javadoccomment">     * lowest whole hour is 2002-11-02T23:00:00.000.</em>
<a name="595" href="#595">595</a> <em class="jxr_javadoccomment">     *</em>
<a name="596" href="#596">596</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to round</em>
<a name="597" href="#597">597</a> <em class="jxr_javadoccomment">     * @return rounded milliseconds</em>
<a name="598" href="#598">598</a> <em class="jxr_javadoccomment">     */</em>
<a name="599" href="#599">599</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> roundFloor(<strong class="jxr_keyword">long</strong> instant);
<a name="600" href="#600">600</a> 
<a name="601" href="#601">601</a>     <em class="jxr_javadoccomment">/**</em>
<a name="602" href="#602">602</a> <em class="jxr_javadoccomment">     * Round to the highest whole unit of this field. The value of this field</em>
<a name="603" href="#603">603</a> <em class="jxr_javadoccomment">     * and all fields of a higher magnitude may be incremented in order to</em>
<a name="604" href="#604">604</a> <em class="jxr_javadoccomment">     * achieve this result. The fractional millis that cannot be expressed in</em>
<a name="605" href="#605">605</a> <em class="jxr_javadoccomment">     * whole increments of this field are set to minimum.</em>
<a name="606" href="#606">606</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="607" href="#607">607</a> <em class="jxr_javadoccomment">     * For example, a datetime of 2002-11-02T23:34:56.789, rounded to the</em>
<a name="608" href="#608">608</a> <em class="jxr_javadoccomment">     * highest whole hour is 2002-11-03T00:00:00.000.</em>
<a name="609" href="#609">609</a> <em class="jxr_javadoccomment">     *</em>
<a name="610" href="#610">610</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to round</em>
<a name="611" href="#611">611</a> <em class="jxr_javadoccomment">     * @return rounded milliseconds</em>
<a name="612" href="#612">612</a> <em class="jxr_javadoccomment">     */</em>
<a name="613" href="#613">613</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> roundCeiling(<strong class="jxr_keyword">long</strong> instant);
<a name="614" href="#614">614</a> 
<a name="615" href="#615">615</a>     <em class="jxr_javadoccomment">/**</em>
<a name="616" href="#616">616</a> <em class="jxr_javadoccomment">     * Round to the nearest whole unit of this field. If the given millisecond</em>
<a name="617" href="#617">617</a> <em class="jxr_javadoccomment">     * value is closer to the floor or is exactly halfway, this function</em>
<a name="618" href="#618">618</a> <em class="jxr_javadoccomment">     * behaves like roundFloor. If the millisecond value is closer to the</em>
<a name="619" href="#619">619</a> <em class="jxr_javadoccomment">     * ceiling, this function behaves like roundCeiling.</em>
<a name="620" href="#620">620</a> <em class="jxr_javadoccomment">     *</em>
<a name="621" href="#621">621</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to round</em>
<a name="622" href="#622">622</a> <em class="jxr_javadoccomment">     * @return rounded milliseconds</em>
<a name="623" href="#623">623</a> <em class="jxr_javadoccomment">     */</em>
<a name="624" href="#624">624</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> roundHalfFloor(<strong class="jxr_keyword">long</strong> instant);
<a name="625" href="#625">625</a> 
<a name="626" href="#626">626</a>     <em class="jxr_javadoccomment">/**</em>
<a name="627" href="#627">627</a> <em class="jxr_javadoccomment">     * Round to the nearest whole unit of this field. If the given millisecond</em>
<a name="628" href="#628">628</a> <em class="jxr_javadoccomment">     * value is closer to the floor, this function behaves like roundFloor. If</em>
<a name="629" href="#629">629</a> <em class="jxr_javadoccomment">     * the millisecond value is closer to the ceiling or is exactly halfway,</em>
<a name="630" href="#630">630</a> <em class="jxr_javadoccomment">     * this function behaves like roundCeiling.</em>
<a name="631" href="#631">631</a> <em class="jxr_javadoccomment">     *</em>
<a name="632" href="#632">632</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to round</em>
<a name="633" href="#633">633</a> <em class="jxr_javadoccomment">     * @return rounded milliseconds</em>
<a name="634" href="#634">634</a> <em class="jxr_javadoccomment">     */</em>
<a name="635" href="#635">635</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> roundHalfCeiling(<strong class="jxr_keyword">long</strong> instant);
<a name="636" href="#636">636</a> 
<a name="637" href="#637">637</a>     <em class="jxr_javadoccomment">/**</em>
<a name="638" href="#638">638</a> <em class="jxr_javadoccomment">     * Round to the nearest whole unit of this field. If the given millisecond</em>
<a name="639" href="#639">639</a> <em class="jxr_javadoccomment">     * value is closer to the floor, this function behaves like roundFloor. If</em>
<a name="640" href="#640">640</a> <em class="jxr_javadoccomment">     * the millisecond value is closer to the ceiling, this function behaves</em>
<a name="641" href="#641">641</a> <em class="jxr_javadoccomment">     * like roundCeiling.</em>
<a name="642" href="#642">642</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="643" href="#643">643</a> <em class="jxr_javadoccomment">     * If the millisecond value is exactly halfway between the floor and</em>
<a name="644" href="#644">644</a> <em class="jxr_javadoccomment">     * ceiling, the ceiling is chosen over the floor only if it makes this</em>
<a name="645" href="#645">645</a> <em class="jxr_javadoccomment">     * field's value even.</em>
<a name="646" href="#646">646</a> <em class="jxr_javadoccomment">     *</em>
<a name="647" href="#647">647</a> <em class="jxr_javadoccomment">     * @param instant  the milliseconds from 1970-01-01T00:00:00Z to round</em>
<a name="648" href="#648">648</a> <em class="jxr_javadoccomment">     * @return rounded milliseconds</em>
<a name="649" href="#649">649</a> <em class="jxr_javadoccomment">     */</em>
<a name="650" href="#650">650</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> roundHalfEven(<strong class="jxr_keyword">long</strong> instant);
<a name="651" href="#651">651</a> 
<a name="652" href="#652">652</a>     <em class="jxr_javadoccomment">/**</em>
<a name="653" href="#653">653</a> <em class="jxr_javadoccomment">     * Returns the fractional duration milliseconds of this field. In other</em>
<a name="654" href="#654">654</a> <em class="jxr_javadoccomment">     * words, calling remainder returns the duration that roundFloor would</em>
<a name="655" href="#655">655</a> <em class="jxr_javadoccomment">     * subtract.</em>
<a name="656" href="#656">656</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="657" href="#657">657</a> <em class="jxr_javadoccomment">     * For example, on a datetime of 2002-11-02T23:34:56.789, the remainder by</em>
<a name="658" href="#658">658</a> <em class="jxr_javadoccomment">     * hour is 34 minutes and 56.789 seconds.</em>
<a name="659" href="#659">659</a> <em class="jxr_javadoccomment">     *</em>
<a name="660" href="#660">660</a> <em class="jxr_javadoccomment">     * @param instant the milliseconds from 1970-01-01T00:00:00Z to get the</em>
<a name="661" href="#661">661</a> <em class="jxr_javadoccomment">     * remainder</em>
<a name="662" href="#662">662</a> <em class="jxr_javadoccomment">     * @return remainder duration, in milliseconds</em>
<a name="663" href="#663">663</a> <em class="jxr_javadoccomment">     */</em>
<a name="664" href="#664">664</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> remainder(<strong class="jxr_keyword">long</strong> instant);
<a name="665" href="#665">665</a> 
<a name="666" href="#666">666</a>     <em class="jxr_javadoccomment">/**</em>
<a name="667" href="#667">667</a> <em class="jxr_javadoccomment">     * Get a suitable debug string.</em>
<a name="668" href="#668">668</a> <em class="jxr_javadoccomment">     * </em>
<a name="669" href="#669">669</a> <em class="jxr_javadoccomment">     * @return debug string</em>
<a name="670" href="#670">670</a> <em class="jxr_javadoccomment">     */</em>
<a name="671" href="#671">671</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String toString();
<a name="672" href="#672">672</a>     
<a name="673" href="#673">673</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

